<!DOCTYPE html>

<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">

<title>Class: Semrush::Report</title>

<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../";
</script>

<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>


<body id="top" class="class">
<nav id="metadata">
  <nav id="home-section" class="section">
  <h3 class="section-header">
    <a href="../index.html">Home</a>
    <a href="../table_of_contents.html#classes">Classes</a>
    <a href="../table_of_contents.html#methods">Methods</a>
  </h3>
</nav>


  <nav id="search-section" class="section project-section" class="initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <h3 class="section-header">
      <input type="text" name="search" placeholder="Search" id="search-field"
             title="Type to search, Up and Down to navigate, Enter to load">
    </h3>
  </form>

  <ul id="search-results" class="initially-hidden"></ul>
</nav>


  <div id="file-metadata">
    <nav id="file-list-section" class="section">
  <h3 class="section-header">Defined In</h3>
  <ul>
    <li>lib/semrush/report.rb
  </ul>
</nav>

    
  </div>

  <div id="class-metadata">
    
    <nav id="parent-class-section" class="section">
  <h3 class="section-header">Parent</h3>
  
  <p class="link"><a href="../Object.html">Object</a>
  
</nav>

    
    <!-- Method Quickref -->
<nav id="method-list-section" class="section">
  <h3 class="section-header">Methods</h3>

  <ul class="link-list">
    
    <li><a href="#method-c-domain">::domain</a>
    
    <li><a href="#method-c-new">::new</a>
    
    <li><a href="#method-c-phrase">::phrase</a>
    
    <li><a href="#method-c-url">::url</a>
    
    <li><a href="#method-i-basics">#basics</a>
    
    <li><a href="#method-i-competitors_adwords">#competitors_adwords</a>
    
    <li><a href="#method-i-competitors_adwords_by_organic">#competitors_adwords_by_organic</a>
    
    <li><a href="#method-i-competitors_organic">#competitors_organic</a>
    
    <li><a href="#method-i-competitors_organic_by_adwords">#competitors_organic_by_adwords</a>
    
    <li><a href="#method-i-keywords_adwords">#keywords_adwords</a>
    
    <li><a href="#method-i-keywords_organic">#keywords_organic</a>
    
    <li><a href="#method-i-method_missing">#method_missing</a>
    
    <li><a href="#method-i-related">#related</a>
    
  </ul>
</nav>

  </div>

  <div id="project-metadata">
    <nav id="fileindex-section" class="section project-section">
  <h3 class="section-header">Pages</h3>

  <ul>
  
    <li class="file"><a href="../Gemfile.html">Gemfile</a>
  
    <li class="file"><a href="../MIT-LICENSE.html">MIT-LICENSE</a>
  
    <li class="file"><a href="../README_rdoc.html">README</a>
  
    <li class="file"><a href="../Rakefile.html">Rakefile</a>
  
  </ul>
</nav>

    <nav id="classindex-section" class="section project-section">
  <h3 class="section-header">Class and Module Index</h3>

  <ul class="link-list">
  
    <li><a href="../Semrush.html">Semrush</a>
  
    <li><a href="../Semrush/Exception.html">Semrush::Exception</a>
  
    <li><a href="../Semrush/Exception/ApiAccessDisabled.html">Semrush::Exception::ApiAccessDisabled</a>
  
    <li><a href="../Semrush/Exception/BadApiKey.html">Semrush::Exception::BadApiKey</a>
  
    <li><a href="../Semrush/Exception/BadArgument.html">Semrush::Exception::BadArgument</a>
  
    <li><a href="../Semrush/Exception/BadQuery.html">Semrush::Exception::BadQuery</a>
  
    <li><a href="../Semrush/Exception/Base.html">Semrush::Exception::Base</a>
  
    <li><a href="../Semrush/Exception/MandatoryParameterDomainNotSetOrEmtpy.html">Semrush::Exception::MandatoryParameterDomainNotSetOrEmtpy</a>
  
    <li><a href="../Semrush/Exception/MandatoryParameterPhraseNotSetOrEmtpy.html">Semrush::Exception::MandatoryParameterPhraseNotSetOrEmtpy</a>
  
    <li><a href="../Semrush/Exception/MandatoryParameterUrlNotSetOrEmtpy.html">Semrush::Exception::MandatoryParameterUrlNotSetOrEmtpy</a>
  
    <li><a href="../Semrush/Exception/NothingFound.html">Semrush::Exception::NothingFound</a>
  
    <li><a href="../Semrush/Exception/UnknownError.html">Semrush::Exception::UnknownError</a>
  
    <li><a href="../Semrush/Exception/WrongFormatOrEmptyKey.html">Semrush::Exception::WrongFormatOrEmptyKey</a>
  
    <li><a href="../Semrush/Report.html">Semrush::Report</a>
  
    <li><a href="../Object.html">Object</a>
  
  </ul>
</nav>

  </div>
</nav>

<div id="documentation">
  <h1 class="class">class Semrush::Report</h1>

  <div id="description" class="description">
    
<h1 id="label-Report+Class"><a href="Report.html">Report</a> Class</h1>

<p>Most of these methods take a hash parameter that may contain the following
keys :</p>
<ul><li>
<p>:db (ex: :db =&gt; “us”)</p>
</li><li>
<p>:api_key (ex: :api_key =&gt; ‘gt97s6d4a6w’)</p>
</li><li>
<p>:limit (ex: :limit =&gt; 2000)</p>
</li><li>
<p>:offset (ex: :offset =&gt; 5)</p>
</li><li>
<p>:export_columns (ex: :export_columns =&gt; “Dn,Rk”)</p>
</li></ul>

  </div><!-- description -->

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    
    <!-- Constants -->
    <section id="constants-list" class="section">
      <h3 class="section-header">Constants</h3>
      <dl>
      
        <dt id="DBS">DBS
        
        <dd class="description">
        
      
        <dt id="REPORT_TYPES">REPORT_TYPES
        
        <dd class="description">
        
      
        <dt id="REQUEST_TYPES">REQUEST_TYPES
        
        <dd class="description">
        
      
      </dl>
    </section>
    

    

    <!-- Methods -->
    
     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
      <h3 class="section-header">Public Class Methods</h3>

    
      <div id="method-c-domain" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">domain</span><span
            class="method-args">(domain, params = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Initializes a report for a specific domain. Takes a hash parameter that may
contain the following keys :</p>
<ul><li>
<p>:db (ex: :db =&gt; “us”)</p>
</li><li>
<p>:api_key (ex: :api_key =&gt; ‘gt97s6d4a6w’)</p>
</li><li>
<p>:limit (ex: :limit =&gt; “”)</p>
</li><li>
<p>:offset (ex: :offset =&gt; “”)</p>
</li><li>
<p>:export_columns (ex: :export_columns =&gt; “”)</p>
</li></ul>
          

          
          <div class="method-source-code" id="domain-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 38</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">domain</span> <span class="ruby-identifier">domain</span>, <span class="ruby-identifier">params</span> = {}
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:request_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:domain</span>, <span class="ruby-value">:request</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">domain</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- domain-source -->
          
        </div>

        

        
      </div><!-- domain-method -->

    
      <div id="method-c-new" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">new</span><span
            class="method-args">(params = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          
          

          
          <div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">params</span> = {}
  <span class="ruby-ivar">@parameters</span> = <span class="ruby-identifier">params</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- new-source -->
          
        </div>

        

        
      </div><!-- new-method -->

    
      <div id="method-c-phrase" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">phrase</span><span
            class="method-args">(phrase, params = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Initializes a report for a specific phrase (or keyword). Takes a hash
parameter that may contain the following keys :</p>
<ul><li>
<p>:db (ex: :db =&gt; “us”)</p>
</li><li>
<p>:api_key (ex: :api_key =&gt; ‘gt97s6d4a6w’)</p>
</li><li>
<p>:limit (ex: :limit =&gt; “”)</p>
</li><li>
<p>:offset (ex: :offset =&gt; “”)</p>
</li><li>
<p>:export_columns (ex: :export_columns =&gt; “”)</p>
</li></ul>
          

          
          <div class="method-source-code" id="phrase-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">phrase</span> <span class="ruby-identifier">phrase</span>, <span class="ruby-identifier">params</span> = {}
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:request_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:phrase</span>, <span class="ruby-value">:request</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">phrase</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- phrase-source -->
          
        </div>

        

        
      </div><!-- phrase-method -->

    
      <div id="method-c-url" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">url</span><span
            class="method-args">(url, params = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Initializes a report for a specific domain. Takes a hash parameter that may
contain the following keys :</p>
<ul><li>
<p>:db (ex: :db =&gt; “us”)</p>
</li><li>
<p>:api_key (ex: :api_key =&gt; ‘gt97s6d4a6w’)</p>
</li><li>
<p>:limit (ex: :limit =&gt; “”)</p>
</li><li>
<p>:offset (ex: :offset =&gt; “”)</p>
</li><li>
<p>:export_columns (ex: :export_columns =&gt; “”)</p>
</li></ul>
          

          
          <div class="method-source-code" id="url-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 58</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">url</span> <span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span> = {}
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:request_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:url</span>, <span class="ruby-value">:request</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">url</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- url-source -->
          
        </div>

        

        
      </div><!-- url-method -->

    
    </section><!-- public-class-method-details -->
  
     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
      <h3 class="section-header">Public Instance Methods</h3>

    
      <div id="method-i-basics" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">basics</span><span
            class="method-args">(params = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Main report. Available for a phrase or a domain. Default columns for a
domain:</p>
<ul><li>
<p>Dn - A site name.</p>
</li><li>
<p>Rk - Rating of sites by the number of visitors coming from the first 20
Google search results</p>
</li><li>
<p>Or - Keywords that this site has in TOP20 Google Organic results</p>
</li><li>
<p>Ot - Estimated number of visitors coming from the first 20 Google search
results (per month)</p>
</li><li>
<p>Oc - Estimated cost of purchasing the same number of visitors</p>
</li><li>
<p>Ad - Keywords that this site has in TOP20 Google AdWords</p>
</li><li>
<p>At - Estimated number of visitors coming from AdWords (per month)</p>
</li><li>
<p>Ac - Estimated expenses of the site for the advertising in AdWords (per
month)</p>
</li></ul>

<p>Default columns for a phrase:</p>
<ul><li>
<p>Ph - The search query which the site has within the first 20 Google search
results</p>
</li><li>
<p>Nq - Average number of queries of this keyword in a month, for the
corresponding local version of Google</p>
</li><li>
<p>Cp - Average price of a click on the AdWords ad for this search query, in
U.S. dollars</p>
</li><li>
<p>Co - Competition of advertisers in AdWords for that term, the higher is the
number - the higher is the competition</p>
</li><li>
<p>Nr - The number of search results - how many pages does Google know for
this query</p>
</li></ul>
          

          
          <div class="method-source-code" id="basics-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 79</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">basics</span> <span class="ruby-identifier">params</span> = {}
  <span class="ruby-identifier">domain?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">request</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:report_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:domain_rank</span>)) <span class="ruby-operator">:</span> <span class="ruby-identifier">request</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:report_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:phrase_this</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- basics-source -->
          
        </div>

        

        
      </div><!-- basics-method -->

    
      <div id="method-i-competitors_adwords" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">competitors_adwords</span><span
            class="method-args">(params = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Competitors in AdWords search report Default columns:</p>
<ul><li>
<p>Dn - Sites competing with this site in AdWords, sorted by the number of
common keywords</p>
</li><li>
<p>Np - Number of common keywords in AdWords that these two sites buy</p>
</li><li>
<p>Ad - Keywords that this site has in TOP20 Google AdWords</p>
</li><li>
<p>At - Estimated number of visitors coming from AdWords (per month)</p>
</li><li>
<p>Ac - Estimated expenses of the site for the advertising in AdWords (per
month)</p>
</li><li>
<p>Or - Keywords that this site has in TOP20 Google Organic results</p>
</li></ul>
          

          
          <div class="method-source-code" id="competitors_adwords-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 160</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">competitors_adwords</span> <span class="ruby-identifier">params</span> = {}
  <span class="ruby-identifier">request</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:report_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:domain_adwords_adwords</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- competitors_adwords-source -->
          
        </div>

        

        
      </div><!-- competitors_adwords-method -->

    
      <div id="method-i-competitors_adwords_by_organic" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">competitors_adwords_by_organic</span><span
            class="method-args">(params = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Potential ad/traffic sellers report Default columns:</p>
<ul><li>
<p>Dn - Sites that get into Google TOP20 for keyword queries that analyzed
site buy in AdWords</p>
</li><li>
<p>Np - The number of keywords which this site has in search results next to
the AdWords ads of the analyzed site</p>
</li><li>
<p>Or - Keywords that this site has in TOP20 Google Organic results</p>
</li><li>
<p>Ot - Estimated number of visitors coming from the first 20 Google search
results (per month)</p>
</li><li>
<p>Oc - Estimated cost of purchasing the same number of visitors</p>
</li><li>
<p>Ad - Keywords that this site has in TOP20 Google AdWords</p>
</li></ul>
          

          
          <div class="method-source-code" id="competitors_adwords_by_organic-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 184</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">competitors_adwords_by_organic</span> <span class="ruby-identifier">params</span> = {}
  <span class="ruby-identifier">request</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:report_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:domain_adwords_organic</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- competitors_adwords_by_organic-source -->
          
        </div>

        

        
      </div><!-- competitors_adwords_by_organic-method -->

    
      <div id="method-i-competitors_organic" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">competitors_organic</span><span
            class="method-args">(params = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Competitors in organic search report Default columns:</p>
<ul><li>
<p>Dn - Sites competing with this site in Google search results, sorted by the
number of common keywords</p>
</li><li>
<p>Np - The number of keywords on which the site is displayed in search
results next to the analyzed site</p>
</li><li>
<p>Or - Keywords that this site has in TOP20 Google Organic results</p>
</li><li>
<p>Ot - Estimated number of visitors coming from the first 20 Google search
results (per month)</p>
</li><li>
<p>Oc - Estimated cost of purchasing the same number of visitors</p>
</li><li>
<p>Ad - Keywords that this site has in TOP20 Google AdWords</p>
</li></ul>
          

          
          <div class="method-source-code" id="competitors_organic-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 148</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">competitors_organic</span> <span class="ruby-identifier">params</span> = {}
  <span class="ruby-identifier">request</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:report_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:domain_organic_organic</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- competitors_organic-source -->
          
        </div>

        

        
      </div><!-- competitors_organic-method -->

    
      <div id="method-i-competitors_organic_by_adwords" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">competitors_organic_by_adwords</span><span
            class="method-args">(params = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Potential ad/traffic buyers report Default columns:</p>
<ul><li>
<p>Dn - The list of sites that buys ads in AdWords for those keywords that the
domain under analyzis has within Google TOP20</p>
</li><li>
<p>Np - Number of keywords on which ads of this particular site appear and the
analyzed site gets within Google TOP20</p>
</li><li>
<p>Ad - Keywords that this site has in TOP20 Google AdWords</p>
</li><li>
<p>At - Estimated number of visitors coming from AdWords (per month)</p>
</li><li>
<p>Ac - Estimated expenses of the site for the advertising in AdWords (per
month)</p>
</li><li>
<p>Or - Keywords that this site has in TOP20 Google Organic results</p>
</li></ul>
          

          
          <div class="method-source-code" id="competitors_organic_by_adwords-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 172</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">competitors_organic_by_adwords</span> <span class="ruby-identifier">params</span> = {}
  <span class="ruby-identifier">request</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:report_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:domain_organic_adwords</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- competitors_organic_by_adwords-source -->
          
        </div>

        

        
      </div><!-- competitors_organic_by_adwords-method -->

    
      <div id="method-i-keywords_adwords" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">keywords_adwords</span><span
            class="method-args">(params = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>AdWords keywords report Can be called for a domain or a URL. Default
columns for a domain:</p>
<ul><li>
<p>Ph - Search query which the site buys in AdWords in Google</p>
</li><li>
<p>Po - The position of the ad at the time of data collection</p>
</li><li>
<p>Pp - The position of the ad at the time of previous data collection</p>
</li><li>
<p>Nq - Average number of queries of this keyword in a month, for the
corresponding local version of Google</p>
</li><li>
<p>Cp - Average price of a click on the AdWords ad for this search query, in
U.S. dollars</p>
</li><li>
<p>Vu - Display URL. This is the URL displayed on your ad to identify your
site to users.</p>
</li><li>
<p>Tr - The ratio of the number of visitors coming to the site from this ad to
all visitors coming from Google AdWords</p>
</li><li>
<p>Tc - The ratio of site’s expenditures on this particular ad to it’s
expenditures on all AdWords ads in general</p>
</li><li>
<p>Co - Competition of advertisers in AdWords for that term, the higher is the
number - the higher is the competition</p>
</li><li>
<p>Nr - The number of search results - how many pages does Google know for
this query</p>
</li><li>
<p>Td - Dynamics of change in the number of search queries in the past 12
months (estimated)</p>
</li><li>
<p>Ur - The destination URL is the exact URL within your website that you want
to send users to from your ad.</p>
</li></ul>

<p>Default columns for a URL:</p>
<ul><li>
<p>Ph - Search query that the URL has within the first 20 Google Organic or
AdWords results</p>
</li><li>
<p>Po - The position of this URL for this keyword in Organic or AdWords
results</p>
</li><li>
<p>Nq - Average number of queries of this keyword in a month, for the
corresponding local version of Google</p>
</li><li>
<p>Cp - Average price of a click on the AdWords ad for this search query, in
U.S. dollars</p>
</li><li>
<p>Co - Competition of advertisers in AdWords for that term, the higher is the
number - the higher is the competition</p>
</li><li>
<p>Tr - The ratio of the number of visitors coming to the URL from this
keyword to all visitors coming</p>
</li><li>
<p>Tc - The ratio of the estimated cost of buying the same number of visitors
for this search query to the estimated cost of purchasing the same number
of targeted visitors coming to this URL</p>
</li><li>
<p>Nr - The number of search results - how many pages does Google know for
this query</p>
</li><li>
<p>Td - Dynamics of change in the number of search queries in the past 12
months (estimated)</p>
</li></ul>
          

          
          <div class="method-source-code" id="keywords_adwords-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 136</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">keywords_adwords</span> <span class="ruby-identifier">params</span> = {}
  <span class="ruby-identifier">url?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">request</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:report_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:url_adwords</span>)) <span class="ruby-operator">:</span> <span class="ruby-identifier">request</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:report_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:domain_adwords</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- keywords_adwords-source -->
          
        </div>

        

        
      </div><!-- keywords_adwords-method -->

    
      <div id="method-i-keywords_organic" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">keywords_organic</span><span
            class="method-args">(params = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Organic Keywords report Can be called for a domain or a URL. Default
columns for a domain:</p>
<ul><li>
<p>Ph - The search query which the site has within the first 20 Google search
results</p>
</li><li>
<p>Po - The position of the site for the search query in Google, at the moment
of data collection</p>
</li><li>
<p>Pp - The position of the site for the search query in Google, for the
previous data collection</p>
</li><li>
<p>Nq - Average number of queries of this keyword in a month, for the
corresponding local version of Google</p>
</li><li>
<p>Cp - Average price of a click on the AdWords ad for this search query, in
U.S. dollars</p>
</li><li>
<p>Ur - URL of a page of the site which is displayed in search results for
this query (landing page)</p>
</li><li>
<p>Tr - The ratio of the number of visitors coming to the site from this
search request to all visitors coming from Google search results</p>
</li><li>
<p>Tc - The ratio of the estimated cost of buying the same number of visitors
for this search query to the estimated cost of purchasing the same number
of targeted visitors coming to this site from Google search results</p>
</li><li>
<p>Co - Competition of advertisers in AdWords for that term, the higher is the
number - the higher is the competition</p>
</li><li>
<p>Nr - The number of search results - how many pages does Google know for
this query</p>
</li><li>
<p>Td - Dynamics of change in the number of search queries in the past 12
months (estimated)</p>
</li></ul>

<p>Default columns for a URL:</p>
<ul><li>
<p>Ph - Search query that the URL has within the first 20 Google Organic or
AdWords results</p>
</li><li>
<p>Po - The position of this URL for this keyword in Organic or AdWords
results</p>
</li><li>
<p>Nq - Average number of queries of this keyword in a month, for the
corresponding local version of Google</p>
</li><li>
<p>Cp - Average price of a click on the AdWords ad for this search query, in
U.S. dollars</p>
</li><li>
<p>Co - Competition of advertisers in AdWords for that term, the higher is the
number - the higher is the competition</p>
</li><li>
<p>Tr - The ratio of the number of visitors coming to the URL from this
keyword to all visitors coming</p>
</li><li>
<p>Tc - The ratio of the estimated cost of buying the same number of visitors
for this search query to the estimated cost of purchasing the same number
of targeted visitors coming to this URL</p>
</li><li>
<p>Nr - The number of search results - how many pages does Google know for
this query</p>
</li><li>
<p>Td - Dynamics of change in the number of search queries in the past 12
months (estimated)</p>
</li></ul>
          

          
          <div class="method-source-code" id="keywords_organic-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 107</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">keywords_organic</span> <span class="ruby-identifier">params</span> = {}
  <span class="ruby-identifier">url?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">request</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:report_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:url_organic</span>)) <span class="ruby-operator">:</span> <span class="ruby-identifier">request</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:report_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:domain_organic</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- keywords_organic-source -->
          
        </div>

        

        
      </div><!-- keywords_organic-method -->

    
      <div id="method-i-method_missing" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">method_missing</span><span
            class="method-args">(method, *args)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Tries to make the api call for the report called as method (see samples on
<a href="http://www.semrush.com/api.html">www.semrush.com/api.html</a>).
Allows calls like:</p>
<ul><li>
<p><a href="Report.html#method-c-new">::new</a>.domain_rank(:request_type
=&gt; :domain, :request =&gt; 'thedomain.com')</p>
</li><li>
<p><a
href="Report.html#method-c-new">::new</a>.domain_organic_organic(:request_type
=&gt; :domain, :request =&gt; 'thedomain.com')</p>
</li><li>
<p><a href="Report.html#method-c-new">::new</a>.phrase_related(:request_type
=&gt; :phrase, :request =&gt; 'the phrase')</p>
</li></ul>
          

          
          <div class="method-source-code" id="method_missing-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 22</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method</span>, *<span class="ruby-identifier">args</span>)
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">super</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">REPORT_TYPES</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">method</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
  <span class="ruby-identifier">request</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:report_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">method</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- method_missing-source -->
          
        </div>

        

        
      </div><!-- method_missing-method -->

    
      <div id="method-i-related" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">related</span><span
            class="method-args">(params = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Related keyword report Default columns:</p>
<ul><li>
<p>Ph - The search query which the site has within the first 20 Google search
results</p>
</li><li>
<p>Nq - Average number of queries of this keyword in a month, for the
corresponding local version of Google</p>
</li><li>
<p>Cp - Average price of a click on the AdWords ad for this search query, in
U.S. dollars</p>
</li><li>
<p>Co - Competition of advertisers in AdWords for that term, the higher is the
number - the higher is the competition</p>
</li><li>
<p>Nr - The number of search results - how many pages does Google know for
this query</p>
</li><li>
<p>Td - Dynamics of change in the number of search queries in the past 12
months (estimated)</p>
</li></ul>
          

          
          <div class="method-source-code" id="related-source">
            <pre><span class="ruby-comment"># File lib/semrush/report.rb, line 196</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">related</span> <span class="ruby-identifier">params</span> = {}
  <span class="ruby-identifier">request</span>(<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:report_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:phrase_related</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- related-source -->
          
        </div>

        

        
      </div><!-- related-method -->

    
    </section><!-- public-instance-method-details -->
  
  </section><!-- 5Buntitled-5D -->

</div><!-- documentation -->


<footer id="validator-badges">
  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11.
  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>

